micromark-util-chunked

micromark-util-chunked

micromark utility to splice and push with giant arrays.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • push(list, items)
  • splice(list, start, remove, items)
• Types
• Compatibility
• Security
• Contribute
• License

What is this?

This package exposes an algorithm to splice for giant arrays, which V8 bugs out on.

When should I use this?

This package might be useful when you are making your own micromark extensions.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install micromark-util-chunked

In Deno with esm.sh:

import {push, splice} from 'https://esm.sh/micromark-util-chunked@1'

In browsers with esm.sh:

<script type="module">
  import {push, splice} from 'https://esm.sh/micromark-util-chunked@1?bundle'
</script>

Use

import {push, splice} from 'micromark-util-chunked'

// …

nextEvents = push(nextEvents, [
  ['enter', events[open][1], context],
  ['exit', events[open][1], context]
])

// …

splice(events, open - 1, index - open + 3, nextEvents)

// …

API

This module exports the identifiers push and splice. There is no default export.

push(list, items)

Append items (an array) at the end of list (another array). When list was empty, returns items instead.

This prevents a potentially expensive operation when list is empty, and adds items in batches to prevent V8 from hanging.

Parameters

• list (Array<unknown>) — list to operate on
• items (Array<unknown>) — items to add to list

Returns

Either list or items (Array<unknown>).

splice(list, start, remove, items)

Like Array#splice, but smarter for giant arrays.

Array#splice takes all items to be inserted as individual argument which causes a stack overflow in V8 when trying to insert 100k items for instance.

Otherwise, this does not return the removed items, and takes items as an array instead of rest parameters.

Parameters

• list (Array<unknown>) — list to operate on
• start (number) — index to remove/insert at (can be negative)
• remove (number) — number of items to remove
• items (Array<unknown>) — items to inject into list

Returns

Nothing (void).

Types

This package is fully typed with TypeScript. It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 16+. Our projects sometimes work with older versions, but this is not guaranteed.

This package works with micromark version 3+.

Security

This package is safe. See security.md in micromark/.github for how to submit a security report.

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organisation, or community you agree to abide by its terms.

License

MIT © Titus Wormer